<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GMimeFilterFrom: GMime 3.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GMime 3.0 Reference Manual">
<link rel="up" href="Filters.html" title="Stream Filters">
<link rel="prev" href="GMimeFilterEnriched.html" title="GMimeFilterEnriched">
<link rel="next" href="GMimeFilterGZip.html" title="GMimeFilterGZip">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GMimeFilterFrom.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GMimeFilterFrom.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="Filters.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GMimeFilterEnriched.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GMimeFilterGZip.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GMimeFilterFrom"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GMimeFilterFrom.top_of_page"></a>GMimeFilterFrom</span></h2>
<p>GMimeFilterFrom — Escape MBox From_ lines</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GMimeFilterFrom.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *
</td>
<td class="function_name">
<a class="link" href="GMimeFilterFrom.html#g-mime-filter-from-new" title="g_mime_filter_from_new ()">g_mime_filter_from_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GMimeFilterFrom.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GMimeFilterFrom.html#GMimeFilterFrom-struct" title="struct GMimeFilterFrom">GMimeFilterFrom</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GMimeFilterFrom.html#GMimeFilterFromMode" title="enum GMimeFilterFromMode">GMimeFilterFromMode</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GMimeFilterFrom.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> <a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a>
        <span class="lineart">╰──</span> GMimeFilterFrom
</pre>
</div>
<div class="refsect1">
<a name="GMimeFilterFrom.description"></a><h2>Description</h2>
<p>A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> used for escaping MBox From_ lines using either the
traditional "&gt;From " or quoted-printable encoding.</p>
</div>
<div class="refsect1">
<a name="GMimeFilterFrom.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="g-mime-filter-from-new"></a><h3>g_mime_filter_from_new ()</h3>
<pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> *
g_mime_filter_from_new (<em class="parameter"><code><a class="link" href="GMimeFilterFrom.html#GMimeFilterFromMode" title="enum GMimeFilterFromMode"><span class="type">GMimeFilterFromMode</span></a> mode</code></em>);</pre>
<p>Creates a new GMimeFilterFrom filter. If <em class="parameter"><code>mode</code></em>
 is
<a class="link" href="GMimeFilterFrom.html#GMIME-FILTER-FROM-MODE-ARMOR:CAPS"><span class="type">GMIME_FILTER_FROM_MODE_ARMOR</span></a>, the from-filter will encode from
lines using the quoted-printable encoding resulting in "=46rom ".
Using the <a class="link" href="GMimeFilterFrom.html#GMIME-FILTER-FROM-MODE-DEFAULT:CAPS"><span class="type">GMIME_FILTER_FROM_MODE_DEFAULT</span></a> or
<a class="link" href="GMimeFilterFrom.html#GMIME-FILTER-FROM-MODE-ESCAPE:CAPS"><span class="type">GMIME_FILTER_FROM_MODE_ESCAPE</span></a> mode (they are the same), from lines
will be escaped to "&gt;From ".</p>
<p>Note: If you plan on using a from-filter in mode ARMOR, you should
remember to also use a <a class="link" href="GMimeFilterBasic.html" title="GMimeFilterBasic"><span class="type">GMimeFilterBasic</span></a> filter with an encoding of
<a class="link" href="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-QUOTEDPRINTABLE:CAPS"><span class="type">GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE</span></a>.</p>
<div class="refsect3">
<a name="g-mime-filter-from-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>filter mode</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-filter-from-new.returns"></a><h4>Returns</h4>
<p> a new from filter with mode <em class="parameter"><code>mode</code></em>
.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GMimeFilterFrom.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GMimeFilterFrom-struct"></a><h3>struct GMimeFilterFrom</h3>
<pre class="programlisting">struct GMimeFilterFrom;</pre>
<p>A filter for armoring or escaping lines beginning with "From ".</p>
<div class="refsect3">
<a name="GMimeFilterFrom.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GMimeFilterFromMode"></a><h3>enum GMimeFilterFromMode</h3>
<p>The mode for a <a class="link" href="GMimeFilterFrom.html" title="GMimeFilterFrom"><span class="type">GMimeFilterFrom</span></a> filter.</p>
<div class="refsect3">
<a name="GMimeFilterFromMode.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GMIME-FILTER-FROM-MODE-DEFAULT:CAPS"></a>GMIME_FILTER_FROM_MODE_DEFAULT</p></td>
<td class="enum_member_description">
<p>Default mode.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GMIME-FILTER-FROM-MODE-ESCAPE:CAPS"></a>GMIME_FILTER_FROM_MODE_ESCAPE</p></td>
<td class="enum_member_description">
<p>Escape 'From ' lines with a '&gt;'</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GMIME-FILTER-FROM-MODE-ARMOR:CAPS"></a>GMIME_FILTER_FROM_MODE_ARMOR</p></td>
<td class="enum_member_description">
<p>QP-Encode 'From ' lines</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GMimeFilterFrom.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>